home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / fish / 001-100 / 001-025 / 003 / ff / ff.man < prev    next >
Text File  |  1995-03-17  |  12KB  |  265 lines
  1.  
  2.  
  3.  
  4.      FFFFFFFF((((1111))))           WWWWaaaannnngggg IIIInnnnssssttttiiiittttuuuutttteeee ((((AAAAuuuugggguuuusssstttt 11110000,,,, 1111999988885555))))            FFFFFFFF((((1111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           ff - fast text formatter
  10.  
  11.      UUUUSSSSAAAAGGGGEEEE
  12.           ffffffff [options] [-] [files]
  13.  
  14.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  15.           _f_f is a simple text formatter for flexible uniform
  16.           formatting of input files.  Program options are used to
  17.           control formatting.  This is in contrast to text formatters
  18.           like _n_r_o_f_f (_1) that require special format requests to be
  19.           part of their input files.  Besides avoiding cryptic format
  20.           requests in text, _f_f is considerably faster than traditional
  21.           formatters like _n_r_o_f_f (_1) and even simple formatters like
  22.           _f_m_t (_1).
  23.  
  24.           The most complicated concept with _f_f is that of a line
  25.           break.  A line break causes an interruption in the filling
  26.           (evening out of the text lines).  Line breaks occur when
  27.           special characters are seen at the beginnings of lines, or
  28.           when all lines are broken.  By default, any non-alphanumeric
  29.           character will cause a break, but this can be controlled
  30.           with the ----BBBB option.  A blank line always causes a break.
  31.  
  32.      OOOOPPPPTTTTIIIIOOOONNNNSSSS
  33.           There are many, many options to allow control of
  34.           indentation, line width, line spacing, filling, pagination
  35.           with headers and footers, line numbering, right
  36.           justification, and perhaps some other things.  They have
  37.           extensive type and range checking that produces diagnostic
  38.           error messages, so warnings of obviously wrong options will
  39.           not be discussed here.  In general, options that imply the
  40.           use of others work the way they should; if the page size is
  41.           set, then pagination is automatically assumed.  Some
  42.           combinations of options give impressive, even artistic,
  43.           effects.  Making a small text file and playing with it is
  44.           the easiest way to learn how the options interact.
  45.  
  46.           ----bbbb   Break all lines of text.  That is, don't even-out lines
  47.                by filling.  By default, text lines are filled.
  48.  
  49.           ----BBBB bbbbrrrreeeeaaaakkkkcccchhhhaaaarrrrssss
  50.                Change the set of characters that cause line breaks at
  51.                the start of lines to _b_r_e_a_k_c_h_a_r_s. By default, any
  52.                characters but letters and numbers cause a break.  A
  53.                good choice for break characters might be "*-+" and
  54.                TABS that might be used for lists.
  55.  
  56.           ----cccc   Center all lines of text.  This option stops all
  57.                filling of text.
  58.  
  59.           ----dddd   Delete white space at the beginning and end of lines.
  60.  
  61.  
  62.  
  63.      Page 1                                           (printed 1/1/86)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      FFFFFFFF((((1111))))           WWWWaaaannnngggg IIIInnnnssssttttiiiittttuuuutttteeee ((((AAAAuuuugggguuuusssstttt 11110000,,,, 1111999988885555))))            FFFFFFFF((((1111))))
  71.  
  72.  
  73.  
  74.                This option is useful to help un-format text to be re-
  75.                formatted.
  76.  
  77.           ----DDDD   Delete empty input lines.  An input line is empty if it
  78.                has no characters, not even invisible character like
  79.                tabs or spaces.  This option can be combined with the
  80.                option to remove white space to delete visibly blank
  81.                lines.
  82.  
  83.           ----ffff ffffooooooootttteeeerrrr
  84.                Set the page footer to the string _f_o_o_t_e_r. This can be
  85.                any string, but if the first character is not a letter
  86.                or a digit, but a punctuation character like /, then
  87.                that character separates the left, center, and right
  88.                fields of a title.  For example, the title
  89.                             "/ff: fast formatter//1985/"
  90.                would have "ff: fast formatter" as a left justified
  91.                field and 1985 as a right justified field on each page.
  92.                Note that there is no middle field in this example, but
  93.                there could have been, between the two consecutive /'s.
  94.                There are two special characters, % and *, that
  95.                respectively are variables for the page number and the
  96.                input file name.  The default page footer is blank.
  97.  
  98.           ----FFFF ffffooooooootttteeeerrrrssssiiiizzzzeeee
  99.                Set the number of blank lines at the bottom of the
  100.                page.  The footer, if any, is placed in the middle of
  101.                the space, which by default, is five lines.  If
  102.                _f_o_o_t_e_r_s_i_z_e is 0, no footer will be printed.
  103.  
  104.           ----hhhh hhhheeeeaaaaddddeeeerrrr
  105.                Set the page header.  See the description of three-part
  106.                titles for the ----ffff ffffooooooootttteeeerrrr option.  The default page
  107.                header is
  108.                                 "|File: *||Page: %|".
  109.  
  110.           ----HHHH hhhheeeeaaaaddddeeeerrrrssssiiiizzzzeeee
  111.                See the description of the footer size.
  112.  
  113.           ----iiii iiiinnnnddddeeeennnntttt
  114.                Set the indentation of the text to _i_n_d_e_n_t spaces.  Note
  115.                that this effectively reduces the usable width of the
  116.                page.
  117.  
  118.           ----IIII tttteeeemmmmppppiiiinnnnddddeeeennnntttt
  119.                Set the temporary indent.  This causes filled text
  120.                found immediately after a break to be indented for one
  121.                line.  It is useful for indenting the first lines of
  122.                paragraphs.  If _t_e_m_p_i_n_d_e_n_t is negative, the the
  123.                temporary indent will be relative to the current _i_n_d_e_n_t
  124.                value.  If the _t_e_m_p_i_n_d_e_n_t value is more negative than
  125.                the _i_n_d_e_n_t value is positive, _f_f will automatically
  126.  
  127.  
  128.  
  129.      Page 2                                           (printed 1/1/86)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      FFFFFFFF((((1111))))           WWWWaaaannnngggg IIIInnnnssssttttiiiittttuuuutttteeee ((((AAAAuuuugggguuuusssstttt 11110000,,,, 1111999988885555))))            FFFFFFFF((((1111))))
  137.  
  138.  
  139.  
  140.                increase _i_n_d_e_n_t.
  141.  
  142.           ----jjjj   Justify the text.  That is, even the right margin by
  143.                inserting spaces in the line.  Only filled text can be
  144.                justified.
  145.  
  146.           ----nnnn   Number all output lines produced by the input text.
  147.                Lines from multiple line spacing or pagination will not
  148.                be numbered.
  149.  
  150.           ----NNNN nnnnuuuummmmbbbbeeeerrrrwwwwiiiiddddtttthhhh
  151.                Set the width of the line numbers.  The default is to
  152.                take up 4 spaces.  Note that this effectively reduces
  153.                the usable part of the page.
  154.  
  155.           ----pppp   Paginate the output.  See the options for page header
  156.                and footer control.
  157.  
  158.           ----PPPP ppppaaaaggggeeeessssiiiizzzzeeee
  159.                Set the number of lines in a page to _p_a_g_e_s_i_z_e. By
  160.                default, the standard 66 line page is assumed.
  161.  
  162.           ----ssss ssssppppaaaacccciiiinnnngggg
  163.                Set the line spacing.  By default, text is single
  164.                spaced (_s_p_a_c_i_n_g equals 1).
  165.  
  166.           ----tttt ttttaaaabbbb
  167.                Set individual absolute and relative tab stops.  These
  168.                values tell the formatter where to put the text (from
  169.                an unfilled line) that follows a tab character.  Each
  170.                tab stop is supplied with its own ----tttt option; there is
  171.                no way to bundle them.  _t_a_b values can be integers
  172.                without a plus sign.  These are _a_b_s_o_l_u_t_e tab settings;
  173.                the tabs go to that position.  The values must increase
  174.                monotonically.  If a _t_a_b value is preceded by a plus
  175.                sign, then it is interpreted _r_e_l_a_t_i_v_e to the previous
  176.                tab setting.  For example, a tab setting of 40 followed
  177.                by one of +20 will set the second tab stop to 60.
  178.  
  179.           ----TTTT ttttaaaabbbbssss
  180.                Set tab stops to every _t_a_b_s spaces.  It is useful to
  181.                get equally spaced tabs.  This option cannot be used
  182.                with the other tab setting option.
  183.  
  184.           ----uuuu   Print All Input Text As Initial Upper-Case Titles, Like
  185.                This Sentence.  This option goes well with the one for
  186.                centering lines.
  187.  
  188.           ----UUUU   Print a usage summary of all the options and stop.
  189.  
  190.           ----wwww wwwwiiiiddddtttthhhh
  191.                Set the page width.  By default, the page width is 72
  192.  
  193.  
  194.  
  195.      Page 3                                           (printed 1/1/86)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      FFFFFFFF((((1111))))           WWWWaaaannnngggg IIIInnnnssssttttiiiittttuuuutttteeee ((((AAAAuuuugggguuuusssstttt 11110000,,,, 1111999988885555))))            FFFFFFFF((((1111))))
  203.  
  204.  
  205.  
  206.                characters.  Note that the usable line length is
  207.                sometimes less than the page width.  If line numbering
  208.                or indentation is requested, these subtract from the
  209.                line length.
  210.  
  211.      EEEEXXXXAAAAMMMMPPPPLLLLEEEESSSS
  212.           Some of these examples can make shell scripts or aliases.
  213.  
  214.           Centered Titles: title
  215.                ff -dcu $*
  216.           Double Spaced Unfilled Paginated indented (for editing): draft
  217.                ff -s 2 -b -p -f "`date`" -i 8 $*
  218.           Program Listing: cpr
  219.                H="@        Dir: `pwd`@@File: *@"
  220.                F="@        $NAME@`date`@Page %@"
  221.                ff -b -N 8 -H 3 -h "$H" -F 3 -f "$F" -T 4 -w 79 -i 2 $*
  222.           Reformat Paragraphed Text: nr
  223.                ff -jd -I 5 -i 10 -w 65 -B "TAB SP'*.@" $*
  224.  
  225.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  226.           Some options are incompatible with others.  For example,
  227.           centered text cannot be right-justified.  _f_f will not allow
  228.           inconsistent combinations of options.
  229.  
  230.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  231.           fmt(1), nroff(1), scribe(1w)
  232.  
  233.      AAAAUUUUTTTTHHHHOOOORRRR
  234.           Gary Perlman (with help from many students)
  235.  
  236.      SSSSTTTTAAAATTTTUUUUSSSS
  237.           Pretty well tested.
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                           (printed 1/1/86)
  262.  
  263.  
  264.  
  265.